Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(auth): correct @auth/qwik documentation and add migration guide #6730

Merged
merged 6 commits into from
Jul 31, 2024

Conversation

cwoolum
Copy link
Contributor

@cwoolum cwoolum commented Jul 27, 2024

fixes #6729

Overview

What is it?

  • Feature / enhancement
  • Bug
  • Docs / tests / types / typos

Description

The new @auth/qwik package has different routes than the original @builder.io/qwik-auth package. In the new package, the routes are no longer prefixed with /api. This can lead to confusion when the user tries to gate pages and gets redirected to a 404.

Use cases and why

    1. Applies to any users that use Auth and are attempting to migrate to the new @auth/qwik package.

Checklist:

  • My code follows the developer guidelines of this project
  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation
  • [N/A] Added new tests to cover the fix / functionality

@cwoolum cwoolum requested a review from a team as a code owner July 27, 2024 17:28
Copy link

changeset-bot bot commented Jul 27, 2024

⚠️ No Changeset found

Latest commit: ad91e9f

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@cwoolum
Copy link
Contributor Author

cwoolum commented Jul 27, 2024

@gioboa , should I also add an alert or warning that notifies users that are upgrading that the routes changed? I think this change might be easy to miss.

@gioboa
Copy link
Member

gioboa commented Jul 27, 2024

👍 that's a great idea. You can add a note for the users that are upgrading

gioboa
gioboa previously approved these changes Jul 28, 2024
Copy link
Member

@gioboa gioboa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @cwoolum

@cwoolum cwoolum changed the title docs(auth): fix for the correct routes that @auth/qwik uses docs(auth): correct @auth/qwik documentation and add migration guide Jul 28, 2024
@cwoolum
Copy link
Contributor Author

cwoolum commented Jul 28, 2024

@gioboa , I added some guidance as well as a couple diffs to help others easily migrate 🙂

Copy link
Member

@gioboa gioboa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks it looks great to me

@gioboa gioboa merged commit 14b27c8 into QwikDev:main Jul 31, 2024
13 of 14 checks passed
maiieul added a commit to maiieul/qwik that referenced this pull request Aug 26, 2024
maiieul added a commit to maiieul/qwik that referenced this pull request Aug 27, 2024
maiieul added a commit to maiieul/qwik that referenced this pull request Aug 27, 2024
maiieul added a commit to maiieul/qwik that referenced this pull request Aug 27, 2024
maiieul added a commit to maiieul/qwik that referenced this pull request Aug 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[🐞] @auth/qwik package does not correctly register routes
2 participants